home *** CD-ROM | disk | FTP | other *** search
/ PC World Komputer 2010 April / PCWorld0410.iso / hity wydania / Ubuntu 9.10 PL / karmelkowy-koliberek-desktop-9.10-i386-PL.iso / casper / filesystem.squashfs / usr / share / perl5 / Mail / Mailer.pod < prev    next >
Text File  |  2008-07-29  |  4KB  |  146 lines
  1. =head1 NAME
  2.  
  3. Mail::Mailer - Simple interface to electronic mailing mechanisms 
  4.  
  5. =head1 INHERITANCE
  6.  
  7.  Mail::Mailer
  8.    is a IO::Handle
  9.  
  10. =head1 SYNOPSIS
  11.  
  12.   use Mail::Mailer;
  13.   use Mail::Mailer qw(mail);    # specifies default mailer
  14.  
  15.   $mailer = Mail::Mailer->new;
  16.   $mailer = Mail::Mailer->new($type, @args);
  17.  
  18.   $mailer->open(\%headers);
  19.   print $mailer $body;
  20.   $mailer->close
  21.       or die "couldn't send whole message: $!\n";
  22.  
  23. =head1 DESCRIPTION
  24.  
  25. Sends mail using any of the built-in methods.  As TYPE argument
  26. to L<new()|Mail::Mailer/"Constructors">, you can specify any of
  27.  
  28. =over 4
  29.  
  30. =item C<sendmail>
  31.  
  32. Use the C<sendmail> program to deliver the mail.
  33.  
  34. =item C<smtp>
  35.  
  36. Use the C<smtp> protocol via Net::SMTP to deliver the mail. The server
  37. to use can be specified in C<@args> with
  38.  
  39.     $mailer = Mail::Mailer->new('smtp', Server => $server);
  40.  
  41. The smtp mailer does not handle C<Cc> and C<Bcc> lines, neither their
  42. C<Resent-*> fellows. The C<Debug> options enables debugging output
  43. from C<Net::SMTP>.
  44.  
  45. You may also use the C<< Auth => [ $user, $password ] >> option for SASL
  46. authentication (requires L<Authen::SASL> and L<MIME::Base64>).
  47.  
  48. =item C<qmail>
  49.  
  50. Use qmail's qmail-inject program to deliver the mail.
  51.  
  52. =item C<testfile>
  53.  
  54. Used for debugging, this displays the data to the file named in
  55. C<$Mail::Mailer::testfile::config{outfile}> which defaults to a file
  56. named C<mailer.testfile>.  No mail is ever sent.
  57.  
  58. =back
  59.  
  60. C<Mail::Mailer> will search for executables in the above order. The
  61. default mailer will be the first one found.
  62.  
  63. =head1 METHODS
  64.  
  65. =head2 Constructors
  66.  
  67. Mail::Mailer-E<gt>B<new>(TYPE, ARGS)
  68.  
  69. =over 4
  70.  
  71. The TYPE is one of the back-end sender implementations, as described in
  72. the DESCRIPTION chapter of this manual page.  The ARGS are passed to
  73. that back-end.
  74.  
  75. =back
  76.  
  77. $obj-E<gt>B<open>(HASH)
  78.  
  79. =over 4
  80.  
  81. The HASH consists of key and value pairs, the key being the name of
  82. the header field (eg, C<To>), and the value being the corresponding
  83. contents of the header field.  The value can either be a scalar
  84. (eg, C<gnat@frii.com>) or a reference to an array of scalars
  85. (C<< eg, ['gnat@frii.com', 'Tim.Bunce@ig.co.uk'] >>).
  86.  
  87. =back
  88.  
  89. =head1 DETAILS
  90.  
  91. =head2 ENVIRONMENT VARIABLES
  92.  
  93. =over 4
  94.  
  95. =item PERL_MAILERS
  96.  
  97. Augments/override the build in choice for binary used to send out
  98. our mail messages.
  99.  
  100. Format:
  101.  
  102.     "type1:mailbinary1;mailbinary2;...:type2:mailbinaryX;...:..."
  103.  
  104. Example: assume you want you use private sendmail binary instead
  105. of mailx, one could set C<PERL_MAILERS> to:
  106.  
  107.     "mail:/does/not/exists:sendmail:$HOME/test/bin/sendmail"
  108.  
  109. On systems which may include C<:> in file names, use C<|> as separator
  110. between type-groups.
  111.  
  112.     "mail:c:/does/not/exists|sendmail:$HOME/test/bin/sendmail"
  113.  
  114. =back
  115.  
  116. =head2 BUGS
  117.  
  118. Mail::Mailer does not help with folding, and does not protect
  119. against various web-script hacker attacks, for instance where
  120. a new-line is inserted in the content of the field.
  121.  
  122. =head1 SEE ALSO
  123.  
  124. This module is part of the MailTools distribution,
  125. F<http://perl.overmeer.net/mailtools/>.
  126.  
  127. =head1 AUTHORS
  128.  
  129. The MailTools bundle was developed by Graham Barr.  Later, Mark
  130. Overmeer took over maintenance without commitment to further development.
  131.  
  132. Mail::Cap by Gisle Aas E<lt>aas@oslonett.noE<gt>.
  133. Mail::Field::AddrList by Peter Orbaek E<lt>poe@cit.dkE<gt>.
  134. Mail::Mailer and Mail::Send by Tim Bunce E<lt>Tim.Bunce@ig.co.ukE<gt>.
  135. For other contributors see ChangeLog.
  136.  
  137. =head1 LICENSE
  138.  
  139. Copyrights 1995-2000 Graham Barr E<lt>gbarr@pobox.comE<gt> and
  140. 2001-2007 Mark Overmeer E<lt>perl@overmeer.netE<gt>.
  141.  
  142. This program is free software; you can redistribute it and/or modify it
  143. under the same terms as Perl itself.
  144. See F<http://www.perl.com/perl/misc/Artistic.html>
  145.  
  146.